<html>
<head>
    <title>XBRLAPI installation suggestions</title>
    <link rel="stylesheet" href="/css/styles.css" type="text/css"/>
    <script type="text/javascript">
        var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
        document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
    </script>
    <script type="text/javascript">
        try {
            var pageTracker = _gat._getTracker("UA-11401995-1");
            pageTracker._setDomainName("none");
            pageTracker._setAllowLinker(true);
            pageTracker._trackPageview();
        } catch (err) {
        }</script>
</head>


<body>

<div class="logo_container">
	<span class="logo">
		<a class="title" href="/">XBRLAPI</a>
	</span>
	<span class="logo_subscript">
		<a class="title" href="http://en.wikipedia.org/wiki/Free_and_open_source_software">Free Open-Source Software</a>
	</span>
</div>

<div id="navcontainer">
    <form action="http://www.xbrlapi.org/search.html" id="cse-search-box">
        <div>
            <input type="hidden" name="cx" value="partner-pub-3957505011939955:jqid48zd81o"/>
            <input type="hidden" name="cof" value="FORID:10"/>
            <input type="hidden" name="ie" value="ISO-8859-1"/>
            <input type="text" name="q" size="31"/>
            <input type="submit" name="sa" value="Search"/>
        </div>
    </form>

    <script
            type="text/javascript"
            src="http://www.google.com/cse/brand?form=cse-search-box&amp;lang=en">
    </script>

    <ul id="navlist">
        <li><a href="/">Home</a></li>
        <li><a href="testConfigurationFile.html">Configuration Properties</a></li>
    </ul>

    <script type="text/javascript"><!--
    google_ad_client = "pub-3957505011939955";
    /* XBRLAPI site */
    google_ad_slot = "4927123290";
    google_ad_width = 160;
    google_ad_height = 600;
    //-->
    </script>
    <script type="text/javascript"
            src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
    </script>

</div>

<div class="content">

    <h1>Using Eclipse with XBRLAPI</h1>

    <h2>Install Eclipse</h2>

    <p>Download and install <a href="http://www.eclipse.org/downloads/">Eclipse version 3.1.2</a>
        or later. You can use the normal or the much larger EE version. Extract
        it to create, say, the ~/programs/eclipse folder. Open Eclipse and and
        set the workspace to, say, the ~/Eclipse directory.</p>

    <h2>Install a SVN plugin</h2>

    <p>
        Create a new project by checking it out from the XBRLAPI Sourceforge Subversion repository.
        First install Eclipse <a href="http://www.eclipse.org/subversive/">Subversive</a>.
    </p>

    <p>
        Use the Install new software option within Eclipse to find
        the collaboration tool plugins and install the Subversion one.
    </p>

    <h2>Check out the XBRLAPI project from the Sourceforge Subversion repository.</h2>

    <p>
        Open the Subversion repository exploring perspective in Eclipse via the windows/perspectives menu.
    </p>

    <p>
        Set up the Subversion repository in Eclipse using URL:
        <code>https://xbrlapi.svn.sourceforge.net/svnroot/xbrlapi</code>
    </p>

    <p>
        Open the XBRLAPI subversion repository to show the branches, tags trunk and www.xbrlapi.org folders.
    </p>

    <p>
        Select the trunk and choose check-out from the context menu to check it out as a project in Eclipse.
        That should set up the project "more or less" correctly.
    </p>

    <p>In the "Java build path" project properties, add two libraries,
        one for the Java runtime library (if it is not there already) and one
        for the XBRLAPI project. (Use: ALT-ENTER =&gt; Java Build Path -&gt; Add
        Library -&gt; User Library) The one for the XBRLAPI project should contain
        all of the JAR files in the java/lib directory that is contained in the
        XBRLAPI project directory. This will ensure that the necessary third
        party JAR files are also on the class path.</p>

    <h2>Enable unit testing from Eclipse</h2>

    <p>Specify the location of the test configuration file. Under
        Windows-&gt;Preferences-&gt;Java-&gt;Installed JREs, for the JRE that you use for
        unit testing, edit the configuration and add the following parameter to
        the set of default virtual machine (VM) arguments:</p>

    <p><code>-Dxbrlapi.test.configuration=/home/geoff/Eclipse/xbrlapi.org/test.configuration.properties</code></p>

    <p>You should now be able to run the full set of tests for the XBRL API except those depending on having
        external eXist databases launched or the embedded eXist database configured. See the <a href="exist.html">eXist
            documentation</a> for details
        of how to work with those modules. Also see <a href="bdbxml.html">the Berkeley XML Database setup
            instructions</a> if you want to test the examples module or that database
        module itself.</p>

    <p>
        <a href="http://sourceforge.net/projects/xbrlapi"><img
                src="http://sflogo.sourceforge.net/sflogo.php?group_id=135539&type=11" width="120" height="30"
                border="0"
                alt="Get Java XBRL API implementation at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a>
    </p>

</div>

</body>
</html>
